Properly document GtkAccessible:accessible-role
authorEmmanuele Bassi <ebassi@gnome.org>
Tue, 25 Aug 2020 10:30:46 +0000 (11:30 +0100)
committerEmmanuele Bassi <ebassi@gnome.org>
Tue, 25 Aug 2020 15:36:08 +0000 (16:36 +0100)
Use a gtk-doc stanza, instead of the GParamSpec strings.

gtk/gtkaccessible.c

index b136f1a946e673199ba1cc7b239d3e509bc41a14..79b56f6eeb38f334139abea4b4f24167d6ab96b8 100644 (file)
@@ -55,6 +55,13 @@ G_DEFINE_INTERFACE (GtkAccessible, gtk_accessible, G_TYPE_OBJECT)
 static void
 gtk_accessible_default_init (GtkAccessibleInterface *iface)
 {
+  /**
+   * GtkAccessible:accessible-role:
+   *
+   * The accessible role of the given #GtkAccessible implementation.
+   *
+   * The accessible role cannot be changed once set.
+   */
   GParamSpec *pspec =
     g_param_spec_enum ("accessible-role",
                        "Accessible Role",